home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 12 / Cream of the Crop 12 (Part II) / Cream of the Crop 12 (Part II).iso / BBS / STBAR20.ZIP / STARBAR.DOC < prev    next >
Encoding:
Text File  |  1996-04-12  |  8.4 KB  |  203 lines
  1.                       StarBar FileLister/Browser V2.0
  2.                            Public Domain Software
  3.               (!) 1996 Larry Monte/StarLab Systems Software
  4. -----------------------------------------------------------------------------
  5.  
  6. Release :     StarBar V2.0 is a Wide-Beta realease due to the fact
  7. Notes   :     it's been completely re-written from the ground up.
  8.               I promise a V2.1 release after I have heard from
  9.               the people using it. If nothing else, I hope to
  10.               include additional language files submitted by our
  11.               international friends to make StarBar available in
  12.               many languages.
  13. -----------------------------------------------------------------------------
  14.  
  15. GUARANTEES:
  16. -----------
  17.               None expressed or implied. If StarBar works for
  18.               you...great. If not, feel free to modify the code
  19.               to work on your system. 
  20. -----------------------------------------------------------------------------
  21.  
  22. OS/2 Sysops:
  23. ------------
  24.               Although effort was made to make StarBar universally
  25.               compatible between DOS and OS/2, there is no promise
  26.               that StarBar will behave properly for you.
  27.               My main concern is the *.CMD files which are used for
  28.               extracting files from within Archives. Because I have
  29.               no access to an OS/2 system, I could not test these
  30.               files properly.
  31.               I suspect they may work, but if they don't you will
  32.               have to modify the CMD files yourself.
  33.               Further, if you do get them to work (or the originals
  34.               work in the first place) please NetMail me the
  35.               corrections so I can include them in the V2.1 release!
  36. -----------------------------------------------------------------------------
  37.  
  38. Why I Created StarBar:
  39. ----------------------
  40.  
  41.               Beats me! It was something to do. What was once an
  42.               experiment to see if I could actually program, it
  43.               grew into the monster we now know.
  44. -----------------------------------------------------------------------------
  45.  
  46.     This file instructs you on the BASIC setup of StarBar. For information
  47.     on customizing colours, hotkeys, etc, see CUSTOM.DOC.
  48.  
  49. -------------==============Basic Setup Instructions=============-------------
  50.  
  51. NOTE: I suggest everyone to setup StarBar by the proceedures outlined below.
  52.       This will make it easier to track down problems if everyone uses the
  53.       program the same way.
  54.  
  55.       The installation of StarBar V2.0 is a little more involved than in
  56.       previous versions, but that's to be expected when providing better
  57.       flexability. If you stay close to the following instructions, you
  58.       should have little or no problem.
  59.  
  60. 1) Make sure ALL your archivers are somewhere in your DOS path! You need to
  61.    do this for your daily BBS operations, so this _should_ be done already
  62.  
  63. 2) Make sure you have the MEX_INCLUDE environment set in your autoexec.bat
  64.    file. Your autoexec.bat should have this line:
  65.  
  66. SET MEX_INCLUDE=c:\max\m
  67.                 ^^^^^^^^^
  68.                 Should be set to where you keep your *.MH MEX files...
  69.  
  70.    If you don't have this set, add the above line to autoexec.bat and reboot
  71.    your computer!
  72.  
  73. 3) Unpack the STBAR20.ZIP archive into a directory off your main BBS dir
  74.    called STARBAR.
  75.    Here, it's : C:\MAX\STARBAR
  76.  
  77. 4) MOVE (not copy) both STARBAR.LH and STARBAR.MH into your ..\m directory.
  78.    Here, it's : C:\MAX\M
  79.    Do not leave a copy of these files in the STARBAR directory. Make sure
  80.    they are in your ..\m dir ONLY!
  81.  
  82. 5) Change to your ..\lang directory and load your main <language>.mad file
  83.    (here it's ENGLISH.MAD) into your favorite text editor.
  84.    NOTE: See CUSTOM.DOC on creating StarBar language files for multiple
  85.          language systems.
  86.    At the end of your language file is a section called "User Heap". You
  87.    may see another include file there. Add the following to this section:
  88.  
  89. ; Include any user heaps here
  90.  
  91. <Other includes may be defined here>
  92. #include <../m/starbar.lh>
  93.  
  94.    I know there is a USER.LH file where other language files can be defined
  95.    but to keep the least amount of confusion, put the above include line
  96.    in the main <language>.mad file.
  97.  
  98. 6) Compile your language file:
  99.  
  100. MAID <Your language here>.mad
  101.  
  102. 7) Change to your ..\m dir and load STARBAR.MH into your favorite text
  103.    editor.
  104.    The first part of this file contains #defines that _MUST_ be changed
  105.    before you compile and run StarBar. Leave the optional changes for now.
  106.    We are more interested in getting StarBar to work at this point.
  107.    Instructions on these changes are within STARBAR.MH, so just follow
  108.    those.
  109.  
  110. 8) After you are finished with the MH file, change to the main StarBar
  111.    directory and compile StarBar using:
  112.  
  113. MEX STARBAR
  114.  
  115.    Note that no other parameters are needed with this version. If you get
  116.    errors, see PROBLEM.DOC for some answers to common problems.
  117.  
  118. 9) Included with StarBar is a MEX program called: STTOG.MEX
  119.    This is a NEW VERSION for StarBar V2.0! Even if you have STTOG already,
  120.    replace it with this version!
  121.    What this does is sets a user's access key to let StarBar know if the
  122.    user wants to use StarBar or the canned FILE_TITLES menu command. The
  123.    distribution of STTOG uses the user access key "O" (not zero) to
  124.    determine the listing type. If you don't use this key for anything
  125.    else, you can leave it as it is and skip to the next step.
  126.    If the "O" key is already used for something else on your BBS, then
  127.    you will need to edit LINE 18 in STTOG.MEX as follows:
  128.  
  129. #define KEY   "O"
  130.  
  131.    Just pick a key not in use. Make sure the key defined here is the same
  132.    as the key you defined in STARBAR.MH.
  133.  
  134. 10) Compile STTOG (in the StarBar dir) using:
  135.  
  136. MEX STTOG
  137.  
  138. 11) Make sure SBHELP0.MEC is in your STARBAR dir, _NOT_ your \MISC dir.
  139.     Compile the help file using:
  140.  
  141. MECCA SBHELP0.MEC
  142.  
  143.    See CUSTOM.DOC for information about using multiple language help files.
  144.  
  145. 12) Make the following changes to your FILE SECTION in MENUS.CTL:
  146.  
  147.     To install the StarBar Toggle (STTOG):
  148.  
  149.         MEX             StarBar\Sttog            Normal "! Toggle StarBar"
  150.                                                          ^
  151.                                                          Or whatever menu
  152.                                                          option you want
  153.                                                          to make it.
  154.     To install StarBar:
  155.  
  156.         MEX             Starbar\StarBar          Normal "File Titles"
  157.         ^^^^^^^^
  158.           This replaces the FILE_TITLES entry in the FILE section.
  159.  
  160. 13) SILT MAX
  161.  
  162. 14) Run StarBar on each node once, and use the V)iew Long Description option
  163.     on each node.
  164.     You need to do this once so StarBar can create a node-specific work
  165.     directory.
  166.     StarBar will report there is no descriptor file on the first run, but
  167.     will work fine after that.
  168.  
  169. That's it. You should have a fully operational copy of StarBar working on
  170. your BBS!
  171. -----------------------------------------------------------------------------
  172. ----------------------About the BAT/CMD/GUS/ACL Files------------------------
  173.  
  174. The distribution setup of StarBar uses batch files which do the external
  175. archive snooping/unpacking. The current *.BAT *.CMD files will work without
  176. need of 3rd party utils. (You only need the archive programs themselves)
  177.  
  178. Included are *.GUS(DOS) & *.ACL(OS/2) files. These are included in case you
  179. wish to use GUS or ACLE to do your archive unpacking. In this case, simply
  180. rename the *.GUS (for DOS) files to *.BAT or *.ACL (for OS/2) files to *.CMD.
  181.  
  182. EG:(DOS)
  183.    You have CONTENT.BAT - Delete or rename these
  184.             GETDESC.BAT
  185.  
  186.             CONTENT.GUS - Copy or rename these to CONTENT.BAT
  187.             GETDESC.GUS                           GETDESC.BAT
  188.  
  189.    (OS/2)
  190.    You have CONTENT.CMD - Delete or rename these
  191.             GETDESC.CMD
  192.  
  193.             CONTENT.ACL - Copy or rename these to CONTENT.CMD
  194.             GETDESC.ACL                           GETDESC.CMD
  195.  
  196.  
  197. NOTE: If you use GUS or ACLE, they _MUST_ be in your main BBS directory, not
  198.       in the StarBar dir!! (The *.BAT/*.CMD's should be in your StarBar dir)
  199. -----------------------------------------------------------------------------
  200.  
  201.  
  202. See Register.Doc for mailing information, if you need to contact me.
  203.